fingerprint5.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef FINGERPRINT5_H
#define FINGERPRINT5_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"




#define FINGERPRINT5_CMD_STATUS                             0x0040
#define FINGERPRINT5_CMD_VERSION                            0x0041
#define FINGERPRINT5_CMD_BIST                               0x0044
#define FINGERPRINT5_CMD_CAPTURE                            0x0050
#define FINGERPRINT5_CMD_ABORT                              0x0052
#define FINGERPRINT5_CMD_IMAGE_DATA                         0x0053
#define FINGERPRINT5_CMD_ENROLL                             0x0054
#define FINGERPRINT5_CMD_IDENTIFY                           0x0055
#define FINGERPRINT5_CMD_LIST_TEMPLATES                     0x0060
#define FINGERPRINT5_CMD_DELETE_TEMPLATE                    0x0061
#define FINGERPRINT5_CMD_GET_SYSTEM_CONFIG                  0x006A
#define FINGERPRINT5_CMD_SET_SYSTEM_CONFIG                  0x006B
#define FINGERPRINT5_CMD_RESET                              0x0072
#define FINGERPRINT5_CMD_SET_DBG_LOG_LEVEL                  0x00B0
#define FINGERPRINT5_CMD_DATA_GET                           0x0101
#define FINGERPRINT5_CMD_NAVIGATION                         0x0200
#define FINGERPRINT5_CMD_GPIO_CONTROL                       0x0300

#define FINGERPRINT5_FRAME_PROTOCOL_VERSION                 0x0004
#define FINGERPRINT5_FRAME_TYPE_REQUEST                     0x11
#define FINGERPRINT5_FRAME_TYPE_RESPONSE                    0x12
#define FINGERPRINT5_FRAME_TYPE_EVENT                       0x13
#define FINGERPRINT5_FRAME_FLAG_HOST                        0x0010
#define FINGERPRINT5_FRAME_FLAG_FW_BL                       0x0020
#define FINGERPRINT5_FRAME_FLAG_FW_APP                      0x0040
#define FINGERPRINT5_FRAME_CMD_MAX_DATA_SIZE                244
#define FINGERPRINT5_FRAME_MAX_SIZE                         256

#define FINGERPRINT5_MAX_VERSION_SIZE                       100
#define FINGERPRINT5_MAX_NUM_TEMPLATES                      12

#define FINGERPRINT5_EVENT_NONE                             0
#define FINGERPRINT5_EVENT_IDLE                             1
#define FINGERPRINT5_EVENT_ARMED                            2
#define FINGERPRINT5_EVENT_FINGER_DETECT                    3
#define FINGERPRINT5_EVENT_FINGER_LOST                      4
#define FINGERPRINT5_EVENT_IMAGE_READY                      5
#define FINGERPRINT5_EVENT_CMD_FAILED                       6

#define FINGERPRINT5_STATE_APP_FW_READY                     0x0001
#define FINGERPRINT5_STATE_CAPTURE                          0x0004
#define FINGERPRINT5_STATE_IMAGE_AVAILABLE                  0x0010
#define FINGERPRINT5_STATE_DATA_TRANSFER                    0x0040
#define FINGERPRINT5_STATE_FINGER_DOWN                      0x0080
#define FINGERPRINT5_STATE_SYS_ERROR                        0x0400
#define FINGERPRINT5_STATE_ENROLL                           0x1000
#define FINGERPRINT5_STATE_IDENTIFY                         0x2000
#define FINGERPRINT5_STATE_NAVIGATION                       0x4000

#define FINGERPRINT5_TEMPLATE_ID_TYPE_NONE                  0x1012
#define FINGERPRINT5_TEMPLATE_ID_TYPE_ALL                   0x2023
#define FINGERPRINT5_TEMPLATE_ID_TYPE_SPECIFIED             0x3034
#define FINGERPRINT5_TEMPLATE_ID_TYPE_NEW                   0x4045

#define FINGERPRINT5_ENROLL_FEEDBACK_DONE                   1
#define FINGERPRINT5_ENROLL_FEEDBACK_PROGRESS               2
#define FINGERPRINT5_ENROLL_FEEDBACK_REJECT_LOW_QUALITY     3
#define FINGERPRINT5_ENROLL_FEEDBACK_REJECT_LOW_COVERAGE    4
#define FINGERPRINT5_ENROLL_FEEDBACK_REJECT_LOW_MOBILITY    5
#define FINGERPRINT5_ENROLL_FEEDBACK_REJECT_OTHER           6
#define FINGERPRINT5_ENROLL_FEEDBACK_PROGRESS_IMMOBILE      7

#define FINGERPRINT5_IDENTIFY_RESULT_MATCH                  0x61EC
#define FINGERPRINT5_IDENTIFY_RESULT_NO_MATCH               0xBAAD

#define FINGERPRINT5_NAV_ORIENTATION_0                      0
#define FINGERPRINT5_NAV_ORIENTATION_90                     1
#define FINGERPRINT5_NAV_ORIENTATION_180                    2
#define FINGERPRINT5_NAV_ORIENTATION_270                    3

#define FINGERPRINT5_GPIO_SUB_CMD_GET                       0
#define FINGERPRINT5_GPIO_SUB_CMD_SET                       1
#define FINGERPRINT5_GPIO_MODE_NOT_USED                     0
#define FINGERPRINT5_GPIO_MODE_OUTPUT_PP                    1
#define FINGERPRINT5_GPIO_MODE_OUTPUT_OD                    2
#define FINGERPRINT5_GPIO_MODE_INPUT_PULL_NONE              3
#define FINGERPRINT5_GPIO_MODE_INPUT_PULL_UP                4
#define FINGERPRINT5_GPIO_MODE_INPUT_PULL_DOWN              5
#define FINGERPRINT5_GPIO_STATE_RESET                       0
#define FINGERPRINT5_GPIO_STATE_SET                         1

#define FINGERPRINT5_SYS_CFG_VERSION                        1
#define FINGERPRINT5_SYS_CFG_FLAG_STATUS_EVT_BOOT           0x00000001
#define FINGERPRINT5_SYS_CFG_FLAG_UART_IN_STOP_MODE         0x00000010
#define FINGERPRINT5_SYS_CFG_FLAG_UART_IRQ_TX               0x00000020
#define FINGERPRINT5_SYS_CFG_UART_BAUDRATE_9600             1
#define FINGERPRINT5_SYS_CFG_UART_BAUDRATE_19200            2
#define FINGERPRINT5_SYS_CFG_UART_BAUDRATE_57600            3
#define FINGERPRINT5_SYS_CFG_UART_BAUDRATE_115200           4
#define FINGERPRINT5_SYS_CFG_UART_BAUDRATE_921600           5
#define FINGERPRINT5_SYS_CFG_TYPE_DEFAULT                   0
#define FINGERPRINT5_SYS_CFG_TYPE_CUSTOM                    1

#define FINGERPRINT5_RX_TIMEOUT_MS                          3000

#define FINGERPRINT5_TX_DRV_BUFFER_SIZE                     256
#define FINGERPRINT5_RX_DRV_BUFFER_SIZE                     256

#define FINGERPRINT5_SET_DATA_SAMPLE_EDGE                   SET_SPI_DATA_SAMPLE_EDGE
#define FINGERPRINT5_SET_DATA_SAMPLE_MIDDLE                 SET_SPI_DATA_SAMPLE_MIDDLE
 // fingerprint5_cmd



#define FINGERPRINT5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.irq = MIKROBUS( mikrobus, MIKROBUS_INT );
 // fingerprint5_map // fingerprint5

typedef enum
{
    FINGERPRINT5_DRV_SEL_UART,      
    FINGERPRINT5_DRV_SEL_SPI        
 
} fingerprint5_drv_t;

typedef struct 
{
    uint16_t cmd_id;                
    uint8_t payload[ FINGERPRINT5_FRAME_CMD_MAX_DATA_SIZE ]; 
    uint16_t payload_len;           
 
} fingerprint5_cmd_t;

typedef struct 
{
    uint16_t evt;                   
    uint16_t state;                 
    uint16_t app_fail;              
 
} fingerprint5_status_t;

typedef struct 
{
    uint32_t unique_id[ 3 ];        
    uint8_t fw_id;                  
    uint8_t fw_fuse_lvl;            
    uint16_t ver_str_len;           
    uint8_t ver_str[ FINGERPRINT5_MAX_VERSION_SIZE ];   
 
} fingerprint5_version_t;

typedef struct 
{
    uint16_t num_templates;         
    uint16_t template_ids[ FINGERPRINT5_MAX_NUM_TEMPLATES ]; 
 
} fingerprint5_list_templates_t;

typedef struct 
{
    uint16_t id;                    
    uint8_t feedback;               
    uint8_t samples_remaining;      
 
} fingerprint5_enroll_t;

typedef struct 
{
    uint16_t match;                 
    uint16_t type;                  
    uint16_t id;                    
    uint16_t tag;                   
 
} fingerprint5_identify_t;

typedef struct 
{
    uint16_t version;               
    uint16_t finger_scan_int_ms;    
    uint32_t sys_flags;             
    uint8_t uart_irq_delay_ms;      
    uint8_t uart_baudrate;          
    uint8_t idfy_max_cons_fails;    
    uint8_t idfy_lockout_time_s;    
    uint16_t idle_time_ms;          
 
} fingerprint5_sys_config_t;

typedef struct
{
    // Output pins
    digital_out_t rst;              
 
    // Input pins
    digital_in_t irq;               
 
    // Modules
    uart_t uart;                    
    spi_master_t spi;               
    
    uint8_t uart_rx_buffer[ FINGERPRINT5_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ FINGERPRINT5_TX_DRV_BUFFER_SIZE ];  
 
    uint8_t      slave_address;     
    pin_name_t   chip_select;       
    fingerprint5_drv_t drv_sel;     
 
    fingerprint5_cmd_t cmd;         
    uint8_t frame[ FINGERPRINT5_FRAME_MAX_SIZE ];   
 
} fingerprint5_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t miso;                
    pin_name_t mosi;                
    pin_name_t sck;                 
    pin_name_t cs;                  
    pin_name_t rx_pin;              
    pin_name_t tx_pin;              
 
    // Additional gpio pins
    pin_name_t rst;                 
    pin_name_t irq;                 
 
    // Static variable
    uint32_t         baud_rate;     
    bool             uart_blocking; 
    uart_data_bits_t data_bit;      
    uart_parity_t    parity_bit;    
    uart_stop_bits_t stop_bit;      
 
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
 
    fingerprint5_drv_t drv_sel;     
 
} fingerprint5_cfg_t;

typedef enum
{
    FINGERPRINT5_OK = 0,
    FINGERPRINT5_ERROR = -1,
    FINGERPRINT5_ERROR_TIMEOUT = -2
 
} fingerprint5_return_value_t;


void fingerprint5_cfg_setup ( fingerprint5_cfg_t *cfg );

err_t fingerprint5_init ( fingerprint5_t *ctx, fingerprint5_cfg_t *cfg );

void fingerprint5_drv_interface_sel ( fingerprint5_cfg_t *cfg, fingerprint5_drv_t drv_sel );

err_t fingerprint5_generic_write ( fingerprint5_t *ctx, uint8_t *data_in, uint16_t len );

err_t fingerprint5_generic_read ( fingerprint5_t *ctx, uint8_t *data_out, uint16_t len );

void fingerprint5_set_rst_pin ( fingerprint5_t *ctx, uint8_t state );

void fingerprint5_reset_device ( fingerprint5_t *ctx );

uint8_t fingerprint5_get_irq_pin ( fingerprint5_t *ctx );

err_t fingerprint5_send_cmd ( fingerprint5_t *ctx );

err_t fingerprint5_read_cmd ( fingerprint5_t *ctx );

err_t fingerprint5_get_status ( fingerprint5_t *ctx );

err_t fingerprint5_get_version ( fingerprint5_t *ctx );

err_t fingerprint5_enroll_finger ( fingerprint5_t *ctx );

err_t fingerprint5_identify_finger ( fingerprint5_t *ctx );

err_t fingerprint5_request_abort ( fingerprint5_t *ctx );

err_t fingerprint5_list_templates ( fingerprint5_t *ctx );

err_t fingerprint5_delete_templates ( fingerprint5_t *ctx );

err_t fingerprint5_request_reset ( fingerprint5_t *ctx );

err_t fingerprint5_start_navigation ( fingerprint5_t *ctx, uint8_t orientation );

err_t fingerprint5_run_bist ( fingerprint5_t *ctx );

err_t fingerprint5_set_gpio ( fingerprint5_t *ctx, uint8_t pin, uint8_t mode, uint8_t state );

err_t fingerprint5_get_gpio ( fingerprint5_t *ctx, uint8_t pin );

err_t fingerprint5_set_config ( fingerprint5_t *ctx, fingerprint5_sys_config_t *config );

err_t fingerprint5_get_config ( fingerprint5_t *ctx, uint8_t type );
 
#ifdef __cplusplus
}
#endif
#endif // FINGERPRINT5_H
 // fingerprint5
 
// ------------------------------------------------------------------------ END